Inside Macintosh: QuickDraw GX Printing /

Chapter 4 - Advanced Printing Features / Advanced Printing Features Reference

Functions / Working With Paper Types

GXGetJobPaperType

You can use the GXGetJobPaperType function to access the specified paper-type object associated with a particular job object.

gxPaperType GXGetJobPaperType (gxJob aJob, long whichPaperType,
                           Boolean forFormatDevice,
                           gxPaperType aPaperType);

aJob

A reference to the job object from which to obtain the paper-type object.

whichPaperType

The index that specifies which paper-type object to obtain.

forFormatDevice

A Boolean value that specifies whether the paper-type objects are associated with the formatting printer (true) or with the output printer (false).

aPaperType

A valid paper-type object reference.

function result

A reference to a paper-type object.

DESCRIPTION

The GXGetJobPaperType function retrieves the specified paper type from the job object based on the index value in the whichPaperType parameter. Index values begin at 1.

Set the forFormatDevice parameter to true to retrieve only the paper types associated with the formatting printer or to false to retrieve only paper types associated with the output printer.

If the desired paper-type object is found, based on its index value, this function replaces the contents of the aPaperType parameter with that of the retrieved paper-type object.

If the paper-type object is not located, the job object's error is set to gxPaperTypeNotFound. Any error generated by this function can be retrieved using the GXGetJobError function.

RESULT CODES

gxSegmentLoadFailedErr	A required code segment could not be found, or there was not enough memory to load it.
gxPaperTypeNotFound	The paper-type object cannot be located.

Main | Page One | What's New | Apple Computer, Inc. | Find It | Contact Us | Help